LIN_UART.h

Go to the documentation of this file.

#ifndef _LIN_UART_H
#define _LIN_UART_H
#include "derivative.h"
/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BITS_IN_32
 #define BITS_IN_32  (32u)
#endif
#ifndef BITS_IN_16
 #define BITS_IN_16  (16u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

#define N_LIN_INSTANCES  (2u)

#define UART_PHYSICAL_BUFF_SIZE (4u)

#define SCI_TIME_OUT   (0x00040000u)

/* Defines for initializing LIN instances */
#define LIN_UART_ENABLED      (0x80000000u)
#define LIN_UART_DISABLED     (0x00000000u)
#define LIN_TX_BUFF_1_BYTES   (0x00000000u)
#define LIN_TX_BUFF_2_BYTES   (0x20000000u)
#define LIN_TX_BUFF_3_BYTES   (0x40000000u)
#define LIN_TX_BUFF_4_BYTES   (0x60000000u)
#define LIN_RX_BUFF_1_BYTES   (0x00000000u)
#define LIN_RX_BUFF_2_BYTES   (0x08000000u)
#define LIN_RX_BUFF_3_BYTES   (0x10000000u)
#define LIN_RX_BUFF_4_BYTES   (0x18000000u)
#define LIN_NO_PARITY_CHECK   (0x00000000u)
#define LIN_ODD_PARITY_CHECK  (0x06000000u)
#define LIN_EVEN_PARITY_CHECK (0x02000000u)
#define LIN_7_BIT_WORD_SIZE   (0x00000000u)
#define LIN_8_BIT_WORD_SIZE   (0x01000000u)

/* UART errors */
#define UART_NO_DATA_RX ((uint8_t)BIT7)
#define UART_INVALID_BUFFER_SIZE ((uint8_t)BIT2)
#define UART_TIMEOUT    ((uint8_t)BIT1)
#define UART_NOT_READY  ((uint8_t)BIT0)

/*** Function Macros ***/
#define LIN_MANTISSA(xx)      (xx << 8u)
#define LIN_FRACTION(xx)      (xx << 20u)

/*** Enums ***/
enum LIN_STATE_MACHINE_STATES
{
  LIN_ASLEEP = 0, LIN_INIT, LIN_IDLE, LIN_BREAK, LIN_BREAK_DELIMITER, 
  LIN_SYNCH_FIELD,  LIN_ID_FIELD, LIN_HEADER_DONE, LIN_DATA_TX_RX, LIN_CHECKSUM
};
enum LIN_INSTANCES_LIST
{
  LIN_INSTANCE_0 = 0, LIN_INSTANCE_1, LIN_INSTANCE_2, LIN_INSTANCE_3
};
enum LIN_UART_BUFFER_REGISTERS
{
  UART_BUFF0 = 0u, UART_BUFF1, UART_BUFF2, UART_BUFF3
};

/*** TypeDefs ***/
typedef volatile struct LINFLEX_tag* LINFLEX_t;

typedef union
{
  struct
  {
    vuint32_t Enable:           1;
    vuint32_t TxBufferSize:     2;
    vuint32_t RxBufferSize:     2;
    vuint32_t OddParityEn:      1;
    vuint32_t ParityCheckEn:    1;
    vuint32_t WordSizeIs8Bits:  1;
    vuint32_t BaudRateFraction: 4;
    vuint32_t BaudRateMantissa: 12;
    vuint32_t Reserved:         6;
    vuint32_t Instance:         2;
  }P;
  vuint32_t W;
} LINUARTConfig_t;
/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Constants ***/
/*** Globals ***/
extern vuint8_t gau8LINUARTWordsTx[N_LIN_INSTANCES];
extern vuint8_t gau8LINUARTWordsRx[N_LIN_INSTANCES];
extern vuint8_t gau8LINUARTRxFlagHasBeenClearedByTx[N_LIN_INSTANCES];
/* Globals for 8-bit transfers */
extern vuint8_t* gpu8LINUARTTxBuffer[N_LIN_INSTANCES];
extern vuint8_t* gpu8LINUARTRxBuffer[N_LIN_INSTANCES];
/*** Static Globals ***/
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          u8fnUARTWrite()
 *
 */
uint8_t u8fnUARTWrite(const uint8_t u8Instance, const uint8_t* pu8UARTTx,
                      const uint8_t u8Size);
/*
 ******************************************************************************
 *
 * Function:          u8fnUARTRead()
 *
 */
uint8_t u8fnUARTRead(const uint8_t u8Instance, const uint8_t* pu8UARTRx,
                     const uint8_t u8Size);
/*
 ******************************************************************************
 *
 * Function:          u8fnLINUARTSend()
 *
 */
uint8_t u8fnLINUARTSend(const uint8_t u8Instance, const uint8_t* pu8UARTTx, \
                        const uint8_t u8Size);
/*
 ******************************************************************************
 *
 * Function:          u8fnLINUARTReceive()
 *
 */
uint8_t u8fnLINUARTReceive(const uint8_t u8Instance, const uint8_t* pu8UARTRx,
                           const uint8_t u8IsrEn);
/*
 ******************************************************************************
 *
 * Function:          u8fnConfigLINUARTGeneral()
 *
 */
uint8_t u8fnConfigLINUARTGeneral(const LINUARTConfig_t* tLINUARTConfig);
/*
 ******************************************************************************
 *
 * Function:          u8fnLINUARTSetTxData()
 *
 */
static uint8_t u8fnLINUARTSetTxData(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          u8fnLINUARTGetDataNoIsr()
 *
 */
uint8_t u8fnLINUARTGetDataNoIsr(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          u8fnLINUARTGetRxData()
 *
 */
static uint8_t u8fnLINUARTGetRxData(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          u8fnLINWriteTxBuffer()
 *
 */
static uint8_t u8fnLINWriteTxBuffer(const uint8_t u8Instance,
                                    const uint8_t u8UARTBufferSize);
/*
 ******************************************************************************
 *
 * Function:          u8fnWaitForUARTTxBufferToEmpty()
 *
 */
uint8_t u8fnWaitForUARTTxBufferToEmpty(uint8_t u8Instance, uint32_t u32TimeOut);
/*
 ******************************************************************************
 *
 * Function:          u8fnReturnLINSMMode()
 *
 */
static uint8_t u8fnReturnLINSMMode(const uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          u8fnChangeSMModeLINUART()
 *
 */
static uint8_t u8fnChangeSMModeLINUART(const uint8_t u8Instance, 
                                       const uint8_t u8Mode);
/*
 ******************************************************************************
 *
 * Function:          u8fnReturnLINTxISRStatus()
 *
 */
static uint8_t u8fnReturnLINTxISRStatus(const uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          u8fnReturnLINRxISRStatus()
 *
 */
static uint8_t u8fnReturnLINRxISRStatus(const uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          vfnEnableLINRxISR()
 *
 */
void vfnEnableLINRxISR(uint8_t u8Instance, uint8_t u8Switch);
/*
 ******************************************************************************
 *
 * Function:          vfnEnableLINTxISR()
 *
 */
void vfnEnableLINTxISR(uint8_t u8Instance, uint8_t u8Switch);
/*
 ******************************************************************************
 *
 * Function:          vfnGenericLINTxIsr()
 *
 */
static void vfnGenericLINTxIsr(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN0TxIsr()
 *
 */
void vfnLIN0TxIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN1TxIsr()
 *
 */
void vfnLIN1TxIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN2TxIsr()
 *
 */
void vfnLIN2TxIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN3TxIsr()
 *
 */
void vfnLIN3TxIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnGenericLINRxIsr()
 *
 */
static void vfnGenericLINRxIsr(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN0RxIsr()
 *
 */
void vfnLIN0RxIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN1RxIsr()
 *
 */
void vfnLIN1RxIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN2RxIsr()
 *
 */
void vfnLIN2RxIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnLIN3RxIsr()
 *
 */
void vfnLIN3RxIsr(void);
#endif /* _FILENAME_H */